-
-
Notifications
You must be signed in to change notification settings - Fork 166
Update Docker PHP Docs for Docker PHP 4.0 #579
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
jaydrogers
merged 174 commits into
280-create-a-frankenphp-variation
from
feature/280-pr-docs-update
Nov 4, 2025
Merged
Update Docker PHP Docs for Docker PHP 4.0 #579
jaydrogers
merged 174 commits into
280-create-a-frankenphp-variation
from
feature/280-pr-docs-update
Nov 4, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Deploying serversideup-php with
|
| Latest commit: |
bfd396b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1cf9d0d3.serversideup-php.pages.dev |
| Branch Preview URL: | https://feature-280-pr-docs-update.serversideup-php.pages.dev |
…EADME for clarity. Refactor app components and CSS for improved styling and structure.
…docs-update # Conflicts: # docs/content/1.getting-started/3.installation.md
…docker-php into feature/280-pr-docs-update
…FPM-NGINX, and FrankenPHP variations. Marked NGINX Unit as deprecated and provided migration guidance. Improved overall structure for better user understanding.
… links to reflect Server Side Up resources.
… and update the icon for better clarity.
…in YAML frontmatter.
…documentation pages to streamline content presentation.
…reflect Server Side Up branding.
…Images branding and SEO metadata
…se of Nuxt UI and providing a link to the Nuxt UI Documentation Template.
…n essential information.
… clarity, removing outdated sections and adding a callout for Docker compatibility.
… "batteries included" approach for improved developer experience.
…and focus on core topics.
…concepts of images vs containers, image layers, volumes, ports, environment variables, and the container lifecycle. This update enhances user understanding of Docker and prepares them for deploying applications from development to production.
…image version 8.3 to 8.4, and clarify the container stopping behavior. Additionally, enhance the environment variable tip with a direct link to the specification for better user guidance.
…iling the transition from development to production images, creating Dockerfiles, best practices, and image versioning strategies. This guide aims to enhance user understanding of building secure and reliable Docker images for production environments.
…se 'compose.yml' for consistency across task scheduler, queue, horizon, and reverb guides.
…' to 'compose.yml' for consistency in configuration examples.
…mpose.yml' instead of 'docker-compose.yml' across all examples.
…addressing common challenges and providing solutions for managing UID/GID alignment between host and container environments. This guide includes examples for development and production setups to enhance user experience and security.
…larity on user and permission management in development environments. Updated image path syntax for consistency and enhanced user understanding of file permission challenges across different operating systems.
…' with 'compose.yml' for consistency across examples.
…on using Docker. Covers deployment challenges, Docker benefits, production image building, deployment strategies, automation, and introduces Spin for simplified workflows. Aims to enhance user confidence in deploying PHP applications.
…yml' for consistency in configuration examples and improve clarity in Docker setup instructions.
… section title for better readability.
…cludes requirements, execution order, and examples for integrating scripts into the entrypoint.d directory, as well as guidance on using S6 Overlay for long-running services.
…s examples for using environment variables and custom php.ini files, along with validation methods to ensure changes are applied correctly.
…roduced icons for DigitalOcean, Hetzner, Vultr, and Sevalla, enhancing visual representation of hosting options in the application.
…ntainerized PHP applications. The guide covers portability, hosting options, recommended hosts, and key considerations for selecting the right host, enhancing user understanding of deployment strategies.
…documentation. Include a link to the guide on using healthchecks with Laravel for better user guidance.
…C_PATH` with `CADDY_SERVER_ROOT` for clarity and consistency. Adjust Caddyfile configuration to reflect the new variable, ensuring accurate root directory settings for the Caddy server.
…ER_ROOT` for improved clarity in server configuration.
…erversideup/php image. This includes usage guidelines, feature comparisons, setup instructions, and environment variable configurations, aimed at enhancing user understanding and adoption of this modern PHP application server.
…ng setup instructions, health check implementation, and performance considerations. Introduce a health check script for Octane to ensure proper application status monitoring.
…proved navigation. Adjusted paths to ensure they are correctly formatted for internal referencing.
…sure users are properly redirected when a page has a redirect property. This change enhances user experience by maintaining expected navigation behavior.
…the `SSL_PRIVATE_KEY_FILE` entry, enhancing clarity on supported configurations for HTTPS.
bfd396b
into
280-create-a-frankenphp-variation
2 of 87 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A Complete Overhaul of the documentation
This PR updates the documentation to use the latest and greatest Nuxt along with Nuxt UI for standardized development. Included in this PR:
Remaining Items
Homepage
Layout
Nest the documentation under
/docs/docsSEO
Documentation
Most of the documentation needs to be migrated. I didn't do all of this because it's going to be heavily updated. Here are some of the documentation migration notes:
Updated Front Matter
The front matter is the YAML that is on the markdown pages. The new format is:
The big difference is we have icons before the documentation. You can find all icons here: https://lucide.dev/icons/. To add the icon it's
i-lucide-{name found on site}. The docs does use Iconify so there could be other providers as well. Lucide fits really nice with the docs though.Migrating Code Embeds
@jaydrogers The biggest thing you will have to update in the documentation is the code embeds. We are using: https://ui.nuxt.com/docs/typography/code#filename. There's also code group: https://ui.nuxt.com/docs/typography/code-group
What you will have to do is remove all
::code-panelcomponents within the docs and update to the new format. There is nolabelso you will have to use anh3tag to label if needed. The new format allows you to set filename though. For an example, check out/docs/content/1.getting-started/3.installation.md. I have an example in there.LLM Data
@jaydrogers We will need to fill out the LLM Data for the docs: https://nuxt.com/modules/llms. This is a new feature that allows you to help LLMs find what they need in your documentation.
It'd also be helpful to provide some sample LLM documentation: https://reka-ui.com/docs/overview/getting-started#example-prompts